Skip to content

feat: add Command prompt constructor #627

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 3 commits into from
Oct 18, 2025
Merged

feat: add Command prompt constructor #627

merged 3 commits into from
Oct 18, 2025
+28 −3

Conversation

@voffie
Copy link
Contributor

@voffie voffie commented Oct 7, 2025 •
edited
Loading

This PR was a follow-up to #600 . It was adding the Terminal module to cli/Command since it was merged before the Terminal module was migrated.

EDIT: Due to changes to main, this branch has diverged into adding the prompt constructor to Command as it was decided upon in the comments of this PR.

@voffie voffie marked this pull request as ready for review October 7, 2025 13:54
@IMax153
Copy link
Member

IMax153 commented Oct 7, 2025

@voffie - should we also take this opportunity to perhaps add back the Command.prompt constructor?

@tim-smart
Copy link
Collaborator

You will need to add NodeTerminal / BunTerminal first :)

@voffie
Copy link
Contributor Author

voffie commented Oct 8, 2025

Is the NodeTerminal / BunTerminal needed for the Command.prompt constructor, or is it a separate concern?

@IMax153
Copy link
Member

IMax153 commented Oct 9, 2025

@voffie - I think we can add it as part of this PR, as otherwise there will be no concrete implementations of Terminal available for use.

@voffie voffie force-pushed the chore/terminal-post-migration branch from 04d4507 to 9165807 Compare October 18, 2025 14:39
@voffie voffie force-pushed the chore/terminal-post-migration branch from 9165807 to d34a89a Compare October 18, 2025 14:47
@voffie voffie changed the title chore: add Terminal to Command environment feat: add Command prompt constructor Oct 18, 2025
IMax153
IMax153 requested changes Oct 18, 2025
View reviewed changes
@github-actions
Copy link

📊 JSDoc Documentation Analysis

📈 Current Analysis Results 
Analyzing 63 TypeScript files in packages/effect/src/ (including schema and config subdirectories)...

============================================================
         EFFECT JSDOC ANALYSIS REPORT
============================================================

📊 SUMMARY STATISTICS
------------------------------
Total files analyzed: 63
Total exported members: 2116
Missing @example: 999 (47.2%)
Missing @category: 338 (16.0%)

🎯 TOP FILES NEEDING ATTENTION
----------------------------------------
1. schema/Schema.ts
   📝 405 missing examples, 🏷️  229 missing categories
   📦 405 total exports
2. schema/AST.ts
   📝 73 missing examples, 🏷️  13 missing categories
   📦 73 total exports
3. schema/Annotations.ts
   📝 38 missing examples, 🏷️  32 missing categories
   📦 38 total exports
4. schema/Getter.ts
   📝 47 missing examples, 🏷️  4 missing categories
   📦 47 total exports
5. PubSub.ts
   📝 25 missing examples, 🏷️  16 missing categories
   📦 37 total exports
6. schema/Transformation.ts
   📝 25 missing examples, 🏷️  14 missing categories
   📦 25 total exports
7. Config.ts
   📝 33 missing examples, 🏷️  5 missing categories
   📦 33 total exports
8. Cause.ts
   📝 28 missing examples, 🏷️  2 missing categories
   📦 69 total exports
9. Effect.ts
   📝 24 missing examples, 🏷️  1 missing categories
   📦 227 total exports
10. SynchronizedRef.ts
   📝 24 missing examples, 🏷️  0 missing categories
   📦 24 total exports
11. schema/Issue.ts
   📝 22 missing examples, 🏷️  2 missing categories
   📦 22 total exports
12. schema/ToParser.ts
   📝 24 missing examples, 🏷️  0 missing categories
   📦 24 total exports
13. ConfigProvider.ts
   📝 21 missing examples, 🏷️  1 missing categories
   📦 21 total exports
14. DateTime.ts
   📝 20 missing examples, 🏷️  0 missing categories
   📦 108 total exports
15. Optic.ts
   📝 18 missing examples, 🏷️  0 missing categories
   📦 18 total exports

✅ PERFECTLY DOCUMENTED FILES
-----------------------------------
   Clock.ts (5 exports)
   Console.ts (21 exports)
   FiberHandle.ts (15 exports)
   FiberMap.ts (19 exports)
   FiberSet.ts (14 exports)
   Match.ts (57 exports)
   MutableRef.ts (17 exports)
   RcRef.ts (5 exports)
   RegExp.ts (3 exports)
   Runtime.ts (3 exports)
   Schedule.ts (49 exports)
   Symbol.ts (1 exports)
   index.ts (0 exports)
   schema/index.ts (0 exports)

🔍 SAMPLE MISSING ITEMS FROM schema/Schema.ts
-----------------------------------
   Optionality (type, line 53): missing example, category
   Mutability (type, line 60): missing example, category
   ConstructorDefault (type, line 67): missing example, category
   MakeOptions (interface, line 75): missing example, category
   Bottom (interface, line 99): missing example, category
   declareConstructor (interface, line 179): missing example, category
   declareConstructor (function, line 203): missing example
   declare (interface, line 227): missing example
   declare (function, line 236): missing example, category
   revealBottom (function, line 256): missing example, category

📋 BREAKDOWN BY EXPORT TYPE
-----------------------------------
type: 123 missing examples, 67 missing categories
const: 378 missing examples, 97 missing categories
interface: 177 missing examples, 106 missing categories
class: 54 missing examples, 3 missing categories
function: 240 missing examples, 50 missing categories
namespace: 27 missing examples, 15 missing categories

📈 DOCUMENTATION PROGRESS
------------------------------
Examples: 1117/2116 (52.8% complete)
Categories: 1778/2116 (84.0% complete)

============================================================
Analysis complete! 1337 items need attention.
============================================================

📄 Detailed results saved to: jsdoc-analysis-results.json

This comment is automatically updated on each push. View the analysis script for details.

@github-actions
Copy link

Bundle Size Analysis

File Name Current Size Previous Size Difference
bundle/basic.ts 6.06 KB 6.06 KB 0.00 KB (0.00%)
bundle/batching.ts 8.30 KB 8.30 KB 0.00 KB (0.00%)
bundle/brand.ts 6.37 KB 6.37 KB 0.00 KB (0.00%)
bundle/cache.ts 9.42 KB 9.42 KB 0.00 KB (0.00%)
bundle/config.ts 15.94 KB 15.94 KB 0.00 KB (0.00%)
bundle/differ.ts 13.74 KB 13.74 KB 0.00 KB (0.00%)
bundle/http-client.ts 18.39 KB 18.39 KB 0.00 KB (0.00%)
bundle/logger.ts 8.56 KB 8.56 KB 0.00 KB (0.00%)
bundle/metric.ts 8.59 KB 8.59 KB 0.00 KB (0.00%)
bundle/optic.ts 7.55 KB 7.55 KB 0.00 KB (0.00%)
bundle/pubsub.ts 12.93 KB 12.93 KB 0.00 KB (0.00%)
bundle/queue.ts 10.83 KB 10.83 KB 0.00 KB (0.00%)
bundle/schedule.ts 9.27 KB 9.27 KB 0.00 KB (0.00%)
bundle/schema-arbitrary.ts 15.74 KB 15.74 KB 0.00 KB (0.00%)
bundle/schema-equivalence.ts 14.83 KB 14.83 KB 0.00 KB (0.00%)
bundle/schema-format.ts 14.93 KB 14.93 KB 0.00 KB (0.00%)
bundle/schema-json-schema.ts 16.24 KB 16.24 KB 0.00 KB (0.00%)
bundle/schema-record-literals-key.ts 13.16 KB 13.16 KB 0.00 KB (0.00%)
bundle/schema-string-async.ts 11.20 KB 11.20 KB 0.00 KB (0.00%)
bundle/schema-string-check.ts 9.99 KB 9.99 KB 0.00 KB (0.00%)
bundle/schema-string.ts 9.54 KB 9.54 KB 0.00 KB (0.00%)
bundle/schema-stringPojo.ts 14.74 KB 14.74 KB 0.00 KB (0.00%)
bundle/schema-template-literal.ts 12.04 KB 12.04 KB 0.00 KB (0.00%)
bundle/schema.ts 14.35 KB 14.35 KB 0.00 KB (0.00%)
bundle/stm.ts 11.66 KB 11.66 KB 0.00 KB (0.00%)
bundle/stream.ts 8.24 KB 8.24 KB 0.00 KB (0.00%)

@IMax153 IMax153 merged commit 9667b60 into Effect-TS:main Oct 18, 2025
13 checks passed
@voffie voffie deleted the chore/terminal-post-migration branch October 18, 2025 15:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@IMax153 IMax153 IMax153 approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@voffie @IMax153 @tim-smart